home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 033a / slgif201.zip / SLGIFCAT.DOC < prev    next >
Text File  |  1992-01-02  |  14KB  |  529 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.                    -----------------------------------------------------
  12.                    S e a r c h l i g h t   G I F   C a t e g o r i z e r
  13.                    -----------------------------------------------------
  14.                                                  for Searchlight BBS 2.x
  15.  
  16.                                                             version 2.01
  17.                                                       Copyright (c) 1991
  18.                                                             Tim Rossiter
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.      =================
  77.      Table of Contents
  78.      =================
  79.  
  80.  
  81.      Table of Contents.................................................i
  82.      Introduction......................................................1
  83.      Registration......................................................1
  84.      Disclaimer........................................................2
  85.      Setup/Installation................................................3
  86.      Running Searchlight GIF Categorizer...............................3
  87.      Command Line Parameters...........................................4
  88.           -w = write changes to Searchlight directories................4
  89.           -n = only display new descriptions...........................4
  90.           -e = add GIF dimensions to end of last description line......4
  91.           -b = add GIF dimensions to beginning of extended description.5
  92.           -s = subtract GIF info from directories......................5
  93.           -c = continuous listing (no more prompt).....................5
  94.           SUBBOARD = name of file subboard to process, or MAIN.........5
  95.      Acknowledgements..................................................6
  96.      Correspondence....................................................6
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.                                         - i -
  129.                           Searchlight GIF Categorizer v2.01
  130.                             Copyright 1991, Tim Rossiter
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.  
  142.      ============
  143.      Introduction
  144.      ============
  145.  
  146.        SLGIFCAT is a utility for Searchlight BBS which will categorize all GIF
  147.      files in a Searchlight BBS DIR file based on the type of video adapter
  148.      required to view the GIF.  The descriptions of GIF files in Searchlight
  149.      directories can then be altered to contain a prefix denoting the video
  150.      type: C=CGA, E=EGA, V=VGA, S=SVGA.  This video type is determined by the
  151.      number of colors described in the GIF file.
  152.  
  153.        SLGIFCAT can also be told to add the dimensions of all GIF files to file
  154.      descriptions.  Several options are provided to for placing the GIF
  155.      dimensions.
  156.  
  157.        Here are some sample of directories entries that have been modified with
  158.      SLGIFCAT:
  159.  
  160.        GIF prefix only:
  161.  
  162.      BART1.GIF         3.9K    8   4-27-91  E:Bart's Facial expression #1
  163.  
  164.        GIF dimensions appended to the end of last description line it fits in:
  165.  
  166.      SCOTTY.GIF       44.0K   14   3-11-89  V:Scotty / Star Trek (320x200x256)
  167.  
  168.      FRANK01.GIF      30.5K   11   9-23-90  V:Frank LaRosa at Searchlight '90
  169.          Mrs. LaRosa -- Can Frankie come out to play? (274x200x64)
  170.  
  171.        GIF dimensions added to the beginning of first available extended
  172.      description:
  173.  
  174.      TOUGHJIM.GIF     85.1K    7  12-05-91  S:Tough guy Jim Barry takes no shit
  175.          The rumors are true!  Jim and Paula are no more!
  176.          (640x400x256)
  177.  
  178.  
  179.      ============
  180.      Registration
  181.      ============
  182.  
  183.        Searchlight GIF Categorizer is distributed as 'shareware', and continued
  184.      use after an acceptable trial period requires a registration fee.  The
  185.      trial period is 21 days (3 weeks), after which, a registration fee of $15
  186.      (US funds) must be paid to the author.  If you fail to register after the
  187.      21 day trial period, you MUST discontinue use of the software.  The only
  188.      way shareware authors are compensated for their efforts is through
  189.      registrations.  Please support the shareware marketing concept and
  190.      encourage authors to produce updates, as well as new shareware programs.
  191.  
  192.  
  193.  
  194.                                         - 1 -
  195.                           Searchlight GIF Categorizer v2.01
  196.                             Copyright 1991, Tim Rossiter
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.  
  206.      ==========
  207.      Disclaimer
  208.      ==========
  209.  
  210.        This program is intended to be used as a door for Searchlight BBS.  It
  211.      has been tested with version 2.15 and should work with later versions as
  212.      well.  Although it has been tested on several BBS systems and works well, I
  213.      still include the following:
  214.  
  215.        UNDER NO CIRCUMSTANCES WILL THE AUTHOR OF THIS PROGRAM BE LIABLE TO
  216.      ANYONE FOR ANY DAMAGES (INCLUDING ANY LOST PROFITS, LOST SAVINGS OR OTHER
  217.      INCIDENTAL OR CONSEQUENTIAL DAMAGES) STEMMING FROM THE USE, MISUSE OR
  218.      INABILITY TO USE THIS PROGRAM, OR FOR ANY CLAIM BY ANY OTHER PARTY.
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.                                         - 2 -
  261.                           Searchlight GIF Categorizer v2.01
  262.                             Copyright 1991, Tim Rossiter
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.  
  272.      ==================
  273.      Setup/Installation
  274.      ==================
  275.  
  276.        The following files should be contained within this ZIP archive:
  277.  
  278.           SLGIFCAT.DOC  -  This SLGIFCAT documentation file
  279.           SLGIFCAT.EXE  -  The actual SLGIFCAT program file
  280.           SLGIFCAT.NEW  -  Update information on SLGIFCAT
  281.           SLGIFCAT.FRM  -  Order form for registering
  282.  
  283.        If any of these file as missing, please ask the sysop of the BBS from
  284.      which you obtained it to remove the archive from his system.
  285.  
  286.        The SLGIFCAT.EXE file can be installed anywhere on your hard drive,
  287.      perhaps in a directory that you store miscellaneous BBS utilities in.
  288.  
  289.  
  290.      ===================================
  291.      Running Searchlight GIF Categorizer
  292.      ===================================
  293.  
  294.        Searchlight GIF Categorizer is easy to use, and features the same user
  295.      interface provided by Searchlight BBS.
  296.  
  297.      Usage:  SLGIFCAT [-w] [-n] [-e | -b | -s] [-c] [MAIN | SUBBOARD]
  298.                -w = write changes to Searchlight directories
  299.                -n = only display new descriptions
  300.                -e = add GIF dimensions to end of last description line
  301.                -b = add GIF dimensions to beginning of extended description
  302.                -s = subtract GIF info from directories
  303.                -c = continuous listing (no more prompt)
  304.          SUBBOARD = name of file subboard to process, or MAIN
  305.  
  306.        *NOTE*  SLGIFCAT must be run from the BBS home directory.  For example,
  307.      if the CONFIG.SL2 file is in the C:\BBS directory, and SLGIFCAT.EXE is in
  308.      the C:\BBS\MISC directory, you can run SLGIFCAT using the following
  309.      commands:
  310.  
  311.           C:
  312.           CD \BBS
  313.           C:\BBS\MISC\SLGIFCAT
  314.  
  315.        SLGIFCAT follows Searchlight's file locking conventions, and is safe to
  316.      use on multi-node systems, even when another user is on-line.
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.                                         - 3 -
  327.                           Searchlight GIF Categorizer v2.01
  328.                             Copyright 1991, Tim Rossiter
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.  
  338.      =======================
  339.      Command Line Parameters
  340.      =======================
  341.  
  342.        SLGIFCAT features several command line parameters that determine how GIF
  343.      information is inserted into file descriptions.  Best of all, SLGIFCAT will
  344.      remove any GIF descriptions that have previously been added to your
  345.      directories before applying the new descriptions.  For example, if SLGIFCAT
  346.      adds GIF dimensions to your directories, it can be run again to take out
  347.      the dimensions, leaving only GIF categories.
  348.  
  349.        SLGIFCAT will truncate some descriptions if there is not enough room to
  350.      insert the GIF information.  Experiment with SLGIFCAT to determine the best
  351.      format for the GIF information on your system.
  352.  
  353.  
  354.      ---------------------------------------------
  355.      -w = write changes to Searchlight directories
  356.      ---------------------------------------------
  357.  
  358.        When the -w parameter is given, SLGIFCAT will update your file
  359.      directories with the new descriptions it has created.  Sysops may wish to
  360.      experiment with SLGIFCAT before using the -w option.
  361.  
  362.  
  363.      ----------------------------------
  364.      -n = only display new descriptions
  365.      ----------------------------------
  366.  
  367.        When the -n parameter is given, SLGIFCAT will only display GIF
  368.      descriptions which are being modified in some way.  If the -n parameter is
  369.      not given, all GIF files will be displayed, even if their description is
  370.      not being changed.
  371.  
  372.  
  373.      -------------------------------------------------------
  374.      -e = add GIF dimensions to end of last description line
  375.      -------------------------------------------------------
  376.  
  377.        The -e parameter will cause SLGIFCAT to place the GIF dimensions at the
  378.      end of the last description line which will fit the dimensions.  The -e
  379.      option cannot be used with the -b or -s options.
  380.  
  381.        *NOTE*  If all description lines are used and there is not enough room
  382.      for the GIF dimensions on the last description line, the end of the second
  383.      extended description line will be truncated to fit the dimensions.
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.                                         - 4 -
  393.                           Searchlight GIF Categorizer v2.01
  394.                             Copyright 1991, Tim Rossiter
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.  
  404.      ------------------------------------------------------------
  405.      -b = add GIF dimensions to beginning of extended description
  406.      ------------------------------------------------------------
  407.  
  408.        The -e parameter will cause SLGIFCAT to place the GIF dimensions at the
  409.      beginning of the first empty extended description line.  The -b option
  410.      cannot be used with the -e or -s options.
  411.  
  412.        *NOTE*  If both lines of the extended description are filled, the second
  413.      extended description line will be overwritten by the GIF dimensions.
  414.  
  415.  
  416.      ---------------------------------------
  417.      -s = subtract GIF info from directories
  418.      ---------------------------------------
  419.  
  420.        The -s parameter instructs SLGIFCAT to remove GIF information from
  421.      directory descriptions.  When used in combination with the -w option, GIF
  422.      information previously added by SLGIFCAT can be permanently removed.  The -
  423.      -s option cannot be used with the -e or -b options.
  424.  
  425.  
  426.      ----------------------------------------
  427.      -c = continuous listing (no more prompt)
  428.      ----------------------------------------
  429.  
  430.        When the -c parameter is given to SLGIFCAT, no more prompts will be
  431.      displayed while SLGIFCAT displays file descriptions.  The -c parameter
  432.      should be used when running SLGIFCAT in an unattended event.
  433.  
  434.  
  435.      ----------------------------------------------------
  436.      SUBBOARD = name of file subboard to process, or MAIN
  437.      ----------------------------------------------------
  438.  
  439.        If a valid subboard name is specified on the command line, SLGIFCAT will
  440.      process directories in the order Searchlight would display directories for
  441.      that subboard.  For example, if your BBS has a subboard called GIFSTUFF and
  442.      you have a GIFSTUFF.DIR file which contains the names of the file
  443.      directories for the GIFSTUFF subboard, SLGIFCAT can be told to only process
  444.      these file directories.
  445.  
  446.        If MAIN is given as a command line parameters, SLGIFCAT will process file
  447.      directories in the order specified by MAIN.DIR, if such a file exists.
  448.  
  449.        If no subboard name is specified on the command line, SLGIFCAT will
  450.      process all file directories in alphabetical order.
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.                                         - 5 -
  459.                           Searchlight GIF Categorizer v2.01
  460.                             Copyright 1991, Tim Rossiter
  461.  
  462.  
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469.  
  470.      ================
  471.      Acknowledgements
  472.      ================
  473.  
  474.           -  Frank LaRosa, author of Searchlight BBS.  Frank's open architecture
  475.              and programmer's library allow programmers to create high quality,
  476.              integrated doors and utilities available on no other bulletin board
  477.              system.
  478.  
  479.           -  Jim Barry, author of Time Vault, who inspires programming
  480.              challenges, and from whom this documentation file is plagiarized.
  481.  
  482.           Created with Searchlight Programmer's Library
  483.           Portions Copyright (c) 1991 Searchlight Software
  484.  
  485.  
  486.      ==============
  487.      Correspondence
  488.      ==============
  489.  
  490.        Comments, suggestions, and registrations may be mailed to:
  491.  
  492.           Tim Rossiter
  493.           c/o One Andrews Circle
  494.           Cleveland, Ohio 44141
  495.  
  496.        Correspondence with Tim Rossiter is welcome via Flip Flop BBS at
  497.      (216)321-5994, or through Searchlight BBS at (516)689-2637.
  498.  
  499.  
  500.  
  501.  
  502.  
  503.  
  504.  
  505.  
  506.  
  507.  
  508.  
  509.  
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.                                         - 6 -
  525.                           Searchlight GIF Categorizer v2.01
  526.                             Copyright 1991, Tim Rossiter
  527.  
  528.  
  529.